<!DOCTYPE html>
<html>
<title>API Document</title>

<xmp theme="united" style="display:none;">
#Swagger Maven Plugin Sample


## HTTP | HTTPS://www.example.com:8080/api


This is a sample.


[**Contact the developer**](mailto:kongchen@gmail.com)


**Version** v1

[**Terms of Service**](http://www.github.com/kongchen/swagger-maven-plugin)

[**Apache 2.0**](http://www.apache.org/licenses/LICENSE-2.0.html)








# Security Definitions


### api_key



<table>
    <tr>
        <th>type</th>
        <th colspan="2">apiKey</th>
    </tr>


        <tr>
            <th>name</th>
            <th colspan="2">api_key</th>
        </tr>


        <tr>
            <th>in</th>
            <th colspan="2">HEADER</th>
        </tr>

</table>




### api_key_2



<table>
        <tr>
            <th>type</th>
            <th colspan="2">apiKey</th>
        </tr>


        <tr>
            <th>name</th>
            <th colspan="2">api_key_2</th>
        </tr>


        <tr>
            <th>in</th>
            <th colspan="2">HEADER</th>
        </tr>

</table>




### basicAuth




<table>
    <tr>
        <th>type</th>
        <th colspan="2">basic</th>
    </tr>

</table>



### petstore_auth


<table>
    <tr>
        <th>type</th>
        <th colspan="2">oauth2</th>
    </tr>


        <tr>
            <th>authorizationUrl</th>
            <th colspan="2">http://swagger.io/api/oauth/dialog</th>
        </tr>


        <tr>
            <th>flow</th>
            <th colspan="2">implicit</th>
        </tr>



    <tr>
        <td rowspan="3">scopes</td>

            <td>write:pets</td>
            <td>modify pets in your account</td>
        </tr>
        <tr>

            <td>read:pets</td>
            <td>read your pets</td>
        </tr>
        <tr>

    </tr>

</table>






# APIs


## /


### GET

<a id="testingRootPathResource">testingRootPathResource</a>









#### Request



##### Parameters






#### Response




| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | string|


















## /myResourceImpl


### GET

<a id="getPetsById">Find pet(s) by ID</a>

This is a contrived example







#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>startId</th>
    <td>query</td>
    <td>yes</td>
    <td>start ID of pets that need to be fetched</td>
    <td> - </td>


            <td>integer (int64)</td>


</tr>

<tr>
    <th>endId</th>
    <td>query</td>
    <td>yes</td>
    <td>end ID of pets that need to be fetched</td>
    <td> - </td>


            <td>integer (int64)</td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|
| 400    | Invalid ID supplied |  - |
| 404    | Pet not found |  - |







### POST


<a id="insertResource">Insert a response</a>

This is a contrived example







#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



    <tr>
        <th>body</th>
        <td>body</td>
        <td>yes</td>
        <td>Resource to insert</td>
        <td> - </td>

        <td>


        </td>

    </tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| default    | successful operation |  - |















## /myResourceImpl/list


### GET

<a id="getListOfItems">Get a list of items</a>

This is a contrived example







#### Request



##### Parameters






#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | Array[<a href="#/definitions/ListItem">ListItem</a>]|


















## /myResourceImpl/{firstParamConcrete}/properties


### GET

<a id="testParamInheritance">Get a response</a>

This is a contrived example







#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>firstParamConcrete</th>
    <td>path</td>
    <td>yes</td>
    <td></td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>secondParamAbstract</th>
    <td>query</td>
    <td>yes</td>
    <td></td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>thirdParamInterface</th>
    <td>query</td>
    <td>no</td>
    <td></td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| default    | successful operation |  - |


















## /pet


### GET

<a id="get">Returns pet</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters






#### Response

**Content-Type: ** application/json


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|





### PUT

<a id="updatePet">Update an existing pet</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request


**Content-Type: ** application/json, application/xml

##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>body</th>
    <td>body</td>
    <td>yes</td>
    <td>Pet object that needs to be added to the store</td>
    <td> - </td>

    <td>

    <a href="#/definitions/Pet">Pet</a>
    </td>

</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 400    | Invalid ID supplied |  - |
| 404    | Pet not found |  - |
| 405    | Validation exception |  - |





### POST


<a id="addPet">Add a new pet to the store</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request


**Content-Type: ** application/json, application/xml

##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>body</th>
    <td>body</td>
    <td>yes</td>
    <td>Pet object that needs to be added to the store</td>
    <td> - </td>

    <td>

    <a href="#/definitions/Pet">Pet</a>
    </td>

</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 405    | Invalid input |  - |















## /pet/findAll


### GET

<a id="findAllPaginated">Finds all Pets</a>

Returns a paginated list of all the Pets.




#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>pageNumber</th>
    <td>query</td>
    <td>yes</td>
    <td>pageNumber</td>
    <td> - </td>


            <td>integer (int32)</td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/PagedListPet">PagedListPet</a>|
| 400    | Invalid page number value |  - |


















## /pet/findByStatus


### GET

<a id="findPetsByStatus">Finds Pets by status</a>

Multiple status values can be provided with comma seperated strings




#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>status</th>
    <td>query</td>
    <td>yes</td>
    <td>Status values that need to be considered for filter</td>
    <td> - </td>


            <td>Array[string] (multi)</td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | Array[<a href="#/definitions/Pet">Pet</a>]|
| 400    | Invalid status value |  - |


















## /pet/findByTags


### GET
-deprecated-
<a id="findPetsByTags">Finds Pets by tags</a>

Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.




#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>tags</th>
    <td>query</td>
    <td>yes</td>
    <td>Tags to filter by</td>
    <td> - </td>


            <td>Array[string] (multi)</td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | Array[<a href="#/definitions/Pet">Pet</a>]|
| 400    | Invalid tag value |  - |


















## /pet/pets/{petName}


### GET

<a id="findPetByPetName">Finds Pets by name</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>petName</th>
    <td>path</td>
    <td>yes</td>
    <td>petName (**Pattern**: `[^/]*`)</td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | Array[<a href="#/definitions/Pet">Pet</a>]|
| 400    | Invalid status value |  - |


















## /pet/test


### GET

<a id="test">Test pet as json string in query</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>pet</th>
    <td>query</td>
    <td>no</td>
    <td>describe Pet in json here</td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|


















## /pet/test/apiimplicitparams/{path-test-name}


### GET

<a id="testapiimplicitparams">Test apiimplicitparams</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>header-test-name</th>
    <td>header</td>
    <td>yes</td>
    <td>header-test-value</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>path-test-name</th>
    <td>path</td>
    <td>yes</td>
    <td>path-test-value</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>body-test-name</th>
    <td>body</td>
    <td>yes</td>
    <td>body-test-value</td>
    <td> - </td>

    <td>

    <a href="#/definitions/Pet">Pet</a>
    </td>

</tr>


</table>



#### Response

**Content-Type: ** application/json


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|


















## /pet/test/extensions


### GET

<a id="testingExtensions">testExtensions</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters






#### Response

**Content-Type: ** text/plain


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|


















## /pet/test/testFormApiImplicitParams


### GET

<a id="testFormApiImplicitParams">Test testFormApiImplicitParams</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>form-test-name</th>
    <td>formData</td>
    <td>yes</td>
    <td>form-test-value</td>
    <td> - </td>


            <td>Array[string] (multi)</td>


</tr>


</table>



#### Response

**Content-Type: ** application/json


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|


















## /pet/test/testingArrayResponse


### GET

<a id="testingArrayResponse">testingArrayResponse</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters






#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | array | Array[<a href="#/definitions/Pet">Pet</a>]|


















## /pet/test/testingBasicAuth


### GET

<a id="testingBasicAuth">testingBasicAuth</a>






#### Security




* basicAuth




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters






#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | string|


















## /pet/test/testingVendorExtensions


### GET

<a id="testingVendorExtensions">testingVendorExtensions</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters






#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 401    | Some vendor error description |  - |
| 501    | Some vendor error description added using swaggerExtension |  - |
| default    | successful operation |  - |


















## /pet/{petId}


### GET

<a id="getPetById">Find pet by ID</a>

Returns a pet when ID &lt; 10.  ID &gt; 10 or nonintegers will simulate API error conditions




#### Security




* api_key




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>petId</th>
    <td>path</td>
    <td>yes</td>
    <td>ID of pet that needs to be fetched (**Pattern**: `[0-9]`)</td>
    <td> - </td>


            <td>integer (int64)</td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|
| 400    | Invalid ID supplied |  - |
| 404    | Pet not found |  - |







### POST


<a id="updatePetWithForm">Updates a pet in the store with form data</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request


**Content-Type: ** application/x-www-form-urlencoded

##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>petId</th>
    <td>path</td>
    <td>yes</td>
    <td>ID of pet that needs to be updated</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>name</th>
    <td>formData</td>
    <td>no</td>
    <td>Updated name of the pet</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>status</th>
    <td>formData</td>
    <td>no</td>
    <td>Updated status of the pet</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>myHeader</th>
    <td>header</td>
    <td>no</td>
    <td></td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>intValue</th>
    <td>header</td>
    <td>no</td>
    <td></td>
    <td> - </td>


    <td>integer (int32)</td>


</tr>

<tr>
    <th>listValue</th>
    <td>query</td>
    <td>no</td>
    <td></td>
    <td> - </td>


            <td>Array[string] (multi)</td>


</tr>

<tr>
    <th>myNestedBeanHeader</th>
    <td>header</td>
    <td>no</td>
    <td>Header from nested bean</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>constructorInjectedHeader</th>
    <td>header</td>
    <td>no</td>
    <td>Header injected at constructor</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>testIntegerAllowableValues</th>
    <td>query</td>
    <td>no</td>
    <td>testIntegerAllowableValues</td>
    <td> - </td>


            <td>integer (int32)</td>


</tr>

<tr>
    <th>constrainedField</th>
    <td>query</td>
    <td>yes</td>
    <td> (**Pattern**: `[0-9]5`)</td>
    <td> - </td>


            <td>integer (int32)</td>


</tr>

<tr>
    <th>myParentHeader</th>
    <td>header</td>
    <td>no</td>
    <td>Header from parent</td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 405    | Invalid input |  - |






### DELETE

<a id="removePet">Deletes a pet</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>api_key</th>
    <td>header</td>
    <td>no</td>
    <td></td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>petId</th>
    <td>path</td>
    <td>yes</td>
    <td>Pet id to delete</td>
    <td> - </td>


            <td>integer (int64)</td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 400    | Invalid pet value |  - |












## /pet/{petId}/testInjectParam






### POST


<a id="updatePetWithFormViaInjectParam">Updates a pet in the store with form data</a>






#### Security




* petstore_auth
   * write:pets
   * read:pets




#### Request


**Content-Type: ** application/x-www-form-urlencoded

##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>petId</th>
    <td>path</td>
    <td>yes</td>
    <td>ID of pet that needs to be updated</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>name</th>
    <td>formData</td>
    <td>no</td>
    <td>Updated name of the pet</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>status</th>
    <td>formData</td>
    <td>no</td>
    <td>Updated status of the pet</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>myHeader</th>
    <td>header</td>
    <td>no</td>
    <td></td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>intValue</th>
    <td>header</td>
    <td>no</td>
    <td></td>
    <td> - </td>


    <td>integer (int32)</td>


</tr>

<tr>
    <th>listValue</th>
    <td>query</td>
    <td>no</td>
    <td></td>
    <td> - </td>


             <td>Array[string] (multi)</td>


</tr>

<tr>
    <th>myNestedBeanHeader</th>
    <td>header</td>
    <td>no</td>
    <td>Header from nested bean</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>constructorInjectedHeader</th>
    <td>header</td>
    <td>no</td>
    <td>Header injected at constructor</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>testIntegerAllowableValues</th>
    <td>query</td>
    <td>no</td>
    <td>testIntegerAllowableValues</td>
    <td> - </td>


            <td>integer (int32)</td>


</tr>

<tr>
    <th>constrainedField</th>
    <td>query</td>
    <td>yes</td>
    <td> (**Pattern**: `[0-9]5`)</td>
    <td> - </td>


            <td>integer (int32)</td>


</tr>

<tr>
    <th>myParentHeader</th>
    <td>header</td>
    <td>no</td>
    <td>Header from parent</td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 405    | Invalid input |  - |















## /pet/{startId}:{endId}


### GET

<a id="getPetsById">Find pet(s) by ID</a>

This is a contrived example of a path segment containing multiple path parameters, separated by a character which may be present in the path parameter template. You may think that it returns a range of pets from startId to endId, inclusive, but it doesn&#x27;t.




#### Security




* api_key




* petstore_auth
   * write:pets
   * read:pets




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>startId</th>
    <td>path</td>
    <td>yes</td>
    <td>start ID of pets that need to be fetched (**Pattern**: `[0-9]{1,2}`)</td>
    <td> - </td>


            <td>integer (int64)</td>


</tr>

<tr>
    <th>endId</th>
    <td>path</td>
    <td>yes</td>
    <td>end ID of pets that need to be fetched (**Pattern**: `[0-9]{1,2}`)</td>
    <td> - </td>


            <td>integer (int64)</td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|
| 400    | Invalid ID supplied |  - |
| 404    | Pet not found |  - |


















## /store/order






### POST


<a id="placeOrder">Place an order for a pet</a>









#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>body</th>
    <td>body</td>
    <td>yes</td>
    <td>order placed for purchasing the pet</td>
    <td> - </td>

    <td>

    <a href="#/definitions/Order">Order</a>
    </td>

</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Order">Order</a>|
| 400    | Invalid Order |  - |















## /store/order/{orderId}


### GET

<a id="getOrderById">Find purchase order by ID</a>

For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions







#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>orderId</th>
    <td>path</td>
    <td>yes</td>
    <td>ID of pet that needs to be fetched</td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Order">Order</a>|
| 400    | Invalid ID supplied |  - |
| 404    | Order not found |  - |









### DELETE

<a id="deleteOrder">Delete purchase order by ID</a>

For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors







#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>orderId</th>
    <td>path</td>
    <td>yes</td>
    <td>ID of the order that needs to be deleted</td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 400    | Invalid ID supplied |  - |
| 404    | Order not found |  - |












## /store/orders/{orderIds}


### GET

<a id="getOrdersById">Find multiple purchase orders by IDs</a>

For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions







#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>orderIds</th>
    <td>path</td>
    <td>yes</td>
    <td>IDs of pets that needs to be fetched</td>
    <td> - </td>


            <td>Array[string] (csv)</td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | Array[<a href="#/definitions/Order">Order</a>]|
| 400    | Invalid ID supplied |  - |
| 404    | Order not found |  - |


















## /store/pingGet


### GET

<a id="pingGet">Simple ping endpoint</a>









#### Request



##### Parameters






#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | Successful request - see response for &#x27;pong&#x27; | string|


















## /store/pingPost






### POST


<a id="pingPost">Simple ping endpoint</a>









#### Request



##### Parameters






#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | Successful request - see response for &#x27;pong&#x27; | string|















## /store/pingPut




### PUT

<a id="pingPut">Simple ping endpoint</a>









#### Request



##### Parameters






#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | Successful request - see response for &#x27;pong&#x27; | string|
















## /swaggerless/subresource/{name}


### GET

<a id="getPetByNameSubresource"></a>









#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>name</th>
    <td>path</td>
    <td>yes</td>
    <td></td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response




| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|


















## /swaggerless/{petId}


### GET

<a id="getPetByName"></a>









#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>name</th>
    <td>path</td>
    <td>yes</td>
    <td></td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response




| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/Pet">Pet</a>|


















## /user






### POST


<a id="createUser">Create user</a>

This can only be done by the logged in user.







#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>body</th>
    <td>body</td>
    <td>yes</td>
    <td>Created user object</td>
    <td> - </td>

    <td>

    <a href="#/definitions/User">User</a>
    </td>

</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| default    | successful operation |  - |















## /user/createWithArray






### POST


<a id="createUsersWithArrayInput">Creates list of users with given input array</a>









#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>body</th>
    <td>body</td>
    <td>yes</td>
    <td>List of user object</td>
    <td> - </td>

    <td>
    Array[<a href="#/definitions/User">User</a>]

    </td>

</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| default    | successful operation |  - |















## /user/createWithList






### POST


<a id="createUsersWithListInput">Creates list of users with given input array</a>









#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>body</th>
    <td>body</td>
    <td>yes</td>
    <td>List of user object</td>
    <td> - </td>

    <td>
    Array[<a href="#/definitions/User">User</a>]

    </td>

</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| default    | successful operation |  - |















## /user/login


### GET

<a id="loginUser">Logs user into the system</a>









#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>username</th>
    <td>query</td>
    <td>yes</td>
    <td>The user name for login</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>password</th>
    <td>query</td>
    <td>yes</td>
    <td>The password for login in clear text</td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | string|
| 400    | Invalid username/password supplied |  - |


















## /user/logout


### GET

<a id="logoutUser">Logs out current logged in user session</a>









#### Request



##### Parameters






#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| default    | successful operation |  - |


















## /user/{username}


### GET

<a id="getUserByName">Get user by user name</a>









#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>username</th>
    <td>path</td>
    <td>yes</td>
    <td>The name that needs to be fetched. Use user1 for testing. </td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | successful operation | <a href="#/definitions/User">User</a>|
| 400    | Invalid username supplied |  - |
| 404    | User not found |  - |





### PUT

<a id="updateUser">Updated user</a>

This can only be done by the logged in user.







#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>username</th>
    <td>path</td>
    <td>yes</td>
    <td>name that need to be deleted</td>
    <td> - </td>


            <td>string </td>


</tr>

<tr>
    <th>body</th>
    <td>body</td>
    <td>yes</td>
    <td>Updated user object</td>
    <td> - </td>

    <td>

    <a href="#/definitions/User">User</a>
    </td>

</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 400    | Invalid user supplied |  - |
| 404    | User not found |  - |







### DELETE

<a id="deleteUser">Delete user</a>

This can only be done by the logged in user.







#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>username</th>
    <td>path</td>
    <td>yes</td>
    <td>The name that needs to be deleted</td>
    <td> - </td>


            <td>string </td>


</tr>


</table>



#### Response

**Content-Type: ** application/json, application/xml


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 400    | Invalid username supplied |  - |
| 404    | User not found |  - |












## /v1.0/sub


### GET

<a id="getUsers">List of users</a>

Get user list




#### Security




* api_key




#### Request



##### Parameters






#### Response

**Content-Type: ** application/json


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | Successful operation | Array[<a href=""></a>]|





### PUT

<a id="updateUser">Update User</a>






#### Security




* api_key




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>body</th>
    <td>body</td>
    <td>yes</td>
    <td>User to be updated</td>
    <td> - </td>

    <td>
    
    <a href="#/definitions/User">User</a> 
    </td>

</tr>


</table>



#### Response

**Content-Type: ** application/json


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | Successful operation |  - |
















## /v1.0/sub/{username}


### GET

<a id="getUserByName">Fetch a user by username</a>






#### Security




* api_key




#### Request



##### Parameters

<table border="1">
    <tr>
        <th>Name</th>
        <th>Located in</th>
        <th>Required</th>
        <th>Description</th>
        <th>Default</th>
        <th>Schema</th>
    </tr>



<tr>
    <th>username</th>
    <td>path</td>
    <td>yes</td>
    <td>Username of user that needs to be fetched</td>
    <td> - </td>

    
            <td>string </td>
    

</tr>


</table>



#### Response

**Content-Type: ** application/json


| Status Code | Reason      | Response Model |
|-------------|-------------|----------------|
| 200    | Successful operation | <a href="#/definitions/User">User</a>|



















# Definitions

## <a name="/definitions/Category">Category</a>

<table border="1">
    <tr>
        <th>name</th>
        <th>type</th>
        <th>required</th>
        <th>description</th>
        <th>example</th>
    </tr>

        <tr>
            <td>id</td>
            <td>


                    integer (int64)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>name</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

</table>

## <a name="/definitions/ListItem">ListItem</a>

<table border="1">
    <tr>
        <th>name</th>
        <th>type</th>
        <th>required</th>
        <th>description</th>
        <th>example</th>
    </tr>

        <tr>
            <td>id</td>
            <td>


                    integer (int64)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

</table>

## <a name="/definitions/Order">Order</a>

<table border="1">
    <tr>
        <th>name</th>
        <th>type</th>
        <th>required</th>
        <th>description</th>
        <th>example</th>
    </tr>

        <tr>
            <td>id</td>
            <td>


                    integer (int64)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>petId</td>
            <td>


                    integer (int64)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>quantity</td>
            <td>


                    integer (int32)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>shipDate</td>
            <td>


                    string (date-time)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>status</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>Order Status</td>
            <td></td>
        </tr>

        <tr>
            <td>complete</td>
            <td>


                    boolean

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>optionalStatus</td>
            <td>


                string

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

</table>

## <a name="/definitions/PagedList">PagedList</a>

<table border="1">
    <tr>
        <th>name</th>
        <th>type</th>
        <th>required</th>
        <th>description</th>
        <th>example</th>
    </tr>

        <tr>
            <td>pageNumber</td>
            <td>


                    integer (int32)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>totalItems</td>
            <td>


                    integer (int32)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>items</td>
            <td>


                    array[object]

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

</table>

## <a name="/definitions/PagedListPet">PagedListPet</a>

<table border="1">
    <tr>
        <th>name</th>
        <th>type</th>
        <th>required</th>
        <th>description</th>
        <th>example</th>
    </tr>

        <tr>
            <td>pageNumber</td>
            <td>


                    integer (int32)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>totalItems</td>
            <td>


                    integer (int32)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>items</td>
            <td>


                    array[<a href="#/definitions/Pet">Pet</a>]



            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

</table>

## <a name="/definitions/Pet">Pet</a>

<table border="1">
    <tr>
        <th>name</th>
        <th>type</th>
        <th>required</th>
        <th>description</th>
        <th>example</th>
    </tr>

        <tr>
            <td>id</td>
            <td>


                    integer

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>category</td>
            <td>

                    <a href="#/definitions/Category">Category</a>


            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>name</td>
            <td>


                    string

            </td>
            <td>required</td>
            <td>-</td>
            <td>doggie</td>
        </tr>

        <tr>
            <td>photoUrls</td>
            <td>


                array[string]

            </td>
            <td>required</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>tags</td>
            <td>


                    array[<a href="#/definitions/Tag">Tag</a>]



            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>status</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>pet status in the store</td>
            <td></td>
        </tr>

</table>

## <a name="/definitions/Tag">Tag</a>

<table border="1">
    <tr>
        <th>name</th>
        <th>type</th>
        <th>required</th>
        <th>description</th>
        <th>example</th>
    </tr>

        <tr>
            <td>id</td>
            <td>


                    integer (int64)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>name</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

</table>

## <a name="/definitions/User">User</a>

<table border="1">
    <tr>
        <th>name</th>
        <th>type</th>
        <th>required</th>
        <th>description</th>
        <th>example</th>
    </tr>

        <tr>
            <td>id</td>
            <td>


                    integer (int64)

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>username</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>firstName</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>lastName</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>email</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>password</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>phone</td>
            <td>


                    string

            </td>
            <td>optional</td>
            <td>-</td>
            <td></td>
        </tr>

        <tr>
            <td>userStatus</td>
            <td>


                    integer (int32)

            </td>
            <td>optional</td>
            <td>User Status</td>
            <td>2</td>
        </tr>

</table>



</xmp>

<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
</html>
